﻿/**
 * @file SerialPortUnixBase.h
 * @author itas109 (itas109@gmail.com) \n\n
 * Blog : http://blog.csdn.net/itas109 \n
 * Github : https://github.com/itas109 \n
 * QQ Group : 12951803
 * @brief the CSerialPort unix Base class unix串口基类
 * @date 2018-12-10
 * 
 * @copyright Copyright (c) 2019 - itas109
 * 
 */
#ifndef __CSERIALPORTUNIXBASE_H__
#define __CSERIALPORTUNIXBASE_H__

#include "SerialPortBase.h"

#include <stdio.h> /* Standard input/output definitions */
#include <string.h> /* String function definitions */
#include <unistd.h> /* UNIX standard function definitions */
#include <fcntl.h> /* File control definitions */
#include <errno.h> /* Error number definitions */
#include <termios.h> /* POSIX terminal control definitions */

#include <sys/ioctl.h> //ioctl

//Serial Programming Guide for POSIX Operating Systems
//https://digilander.libero.it/robang/rubrica/serial.htm
//https://blog.csdn.net/u014650722/article/details/51610587

// sigslot
// https://sourceforge.net/p/sigslot/bugs/8/
#include "sigslot.h"

//https://blog.csdn.net/u010317005/article/details/52384890

// Linux compile
// g++ SerialPort.cpp SerialPortBase.cpp SerialPortUnixBase.cpp -fPIC -shared -o libss.so
// g++ t.cpp -o tt -L. -lss 

//t.cpp
/*
#include <iostream>
#include "sigslot.h"
#include "SerialPort.h"

using namespace itas109;
using namespace std;

int main()
{
	CSerialPort sp;
	sp.init("/dev/ttyS0");
	sp.open();
	cout << sp.isOpened() <<endl;

	while (1);
	return 0;
}
*/

/**
 * @brief the CSerialPort unix Base class unix串口基类
 * @see inherit 继承 CSerialPortBase
 * 
 */
class CSerialPortUnixBase :	public CSerialPortBase
{
public:
	/**
	 * @brief Construct a new CSerialPortUnixBase object 构造函数
	 * 
	 */
	CSerialPortUnixBase();
	/**
	 * @brief Construct a new CSerialPortUnixBase object 通过串口名称构造函数
	 * 
	 * @param portName [in] the port name 串口名称 Windows:COM1 Linux:/dev/ttyS0
	 */
	CSerialPortUnixBase(const std::string & portName);
	/**
	 * @brief Destroy the CSerialPortUnixBase object 析构函数
	 * 
	 */
	virtual ~CSerialPortUnixBase();

	/**
	 * @brief parameter init 参数初始化
	 *
	 */
	virtual void construct();

	/**
	 * @brief init 初始化函数
	 *
	 * @param portName [in] the port name串口名称 Windows:COM1 Linux:/dev/ttyS0
	 * @param baudRate [in] the baudRate 波特率
	 * @param parity [in] the parity 校验位
	 * @param dataBits [in] the dataBits 数据位
	 * @param stopbits [in] the stopbits 停止位
	 * @param flowConctrol [in] flowConctrol type 流控制
	 * @param readBufferSize [in] the read buffer size 读取缓冲区大小
	 */
	virtual void init(std::string portName, int baudRate = itas109::BaudRate9600, itas109::Parity parity = itas109::ParityNone, itas109::DataBits dataBits = itas109::DataBits8, itas109::StopBits stopbits = itas109::StopOne, itas109::FlowConctrol flowConctrol = itas109::FlowNone, int64 readBufferSize = 512);
	/**
	 * @brief  init 初始化函数
	 *
	 * @param port [in] the port number 串口号
	 * @param baudRate [in] the baudRate 波特率
	 * @param parity [in] the parity 校验位
	 * @param dataBits [in] the dataBits 数据位
	 * @param stopbits [in] the stopbits 停止位
	 * @param flowConctrol [in] flowConctrol type 流控制
	 * @param readBufferSize [in] the read buffer size 读取缓冲区大小
	 */
	virtual void init(int port, int baudRate = itas109::BaudRate9600, itas109::Parity parity = itas109::ParityNone, itas109::DataBits dataBits = itas109::DataBits8, itas109::StopBits stopbits = itas109::StopOne, itas109::FlowConctrol flowConctrol = itas109::FlowNone, int64 readBufferSize = 512);

	/**
	 * @brief open serial port 打开串口
	 *
	 * @return
	 * @retval true open success 打开成功
	 * @retval false open failed 打开失败
	 */
    virtual bool openPort();
	/**
	 * @brief close 关闭串口
	 *
	 */
    virtual void closePort();

	/**
	 * @brief if serial port is open success 串口是否打开成功
	 *
	 * @return
	 * @retval true serial port open success 串口打开成功
	 * @retval false serial port open failed 串口打开失败
	 */
	virtual bool isOpened();

	/**
	 * @brief read specified length data 读取指定长度数据
	 *
	 * @param data [out] read data result 读取结果
	 * @param maxSize [in] read length 读取长度
	 * @return return number Of bytes read 返回读取字节数
	 * @retval -1 read error 读取错误
	 * @retval [other] return number Of bytes read 返回读取字节数
	 */
	virtual int readData(char *data, int maxSize);
	/**
	 * @brief read all data 读取所有数据
	 *
	 * @param data [out] read data result 读取结果
	 * @return return number Of bytes read 返回读取字节数
	 * @retval -1 read error 读取错误
	 * @retval [other] return number Of bytes read 返回读取字节数
	 */
	virtual int readAllData(char *data);
	/**
	 * @brief read line data 读取一行字符串
	 * @todo Not implemented 未实现
	 *
	 * @param data
	 * @param maxSize
	 * @return int
	 */
	virtual int	readLineData(char *data, int maxSize);
	/**
	 * @brief write specified lenfth data 写入指定长度数据
	 *
	 * @param data [in] write data 待写入数据
	 * @param maxSize [in] wtite length 写入长度
	 * @return return number Of bytes write 返回写入字节数
	 * @retval -1 read error 写入错误
	 * @retval [other] return number Of bytes write 返回写入字节数
	 */
	virtual int writeData(const char * data, int maxSize);

	/**
	 * @brief Set Debug Model 设置调试模式
	 * @details output serial port read and write details info 输出串口读写的详细信息
	 * @todo  Not implemented 未实现
	 *
	 * @param isDebug true if enable true为启用
	 */
	virtual void setDebugModel(bool isDebug);

	/**
	 * @brief Set the Read Time Interval object
	 * @details use timer import effectiveness 使用定时器提高效率
	 * @todo  Not implemented 未实现
	 *
	 * @param msecs read time micro second 读取间隔时间，单位：毫秒
	 */
	virtual void setReadTimeInterval(int msecs);

	/**
	 * @brief Get the Last Error object 获取最后的错误代码
	 *
	 * @return return last error code, refrence {@link itas109::SerialPortError} 错误代码
	 */
	virtual int getLastError() const;
	/**
	 * @brief clear error 清除错误信息
	 *
	 */
	virtual void clearError();

	/**
	 * @brief Set the Port Name object 设置串口名称
	 *
	 * @param portName [in] the port name 串口名称 Windows:COM1 Linux:/dev/ttyS0
	 */
	virtual void setPortName(std::string portName);
	/**
	 * @brief Get the Port Name object 获取串口名称
	 *
	 * @return return port name 返回串口名称
	 */
	virtual std::string getPortName() const;

	/**
	 * @brief Set the Baud Rate object 设置波特率
	 *
	 * @param baudRate [in] the baudRate 波特率
	 */
	virtual void setBaudRate(int baudRate);
	/**
	 * @brief Get the Baud Rate object 获取波特率
	 *
	 * @return return baudRate 返回波特率
	 */
	virtual int getBaudRate() const;

	/**
	 * @brief Set the Parity object 设置校验位
	 *
	 * @param parity [in] the parity 校验位 {@link itas109::Parity}
	 */
	virtual void setParity(itas109::Parity parity);
	/**
	 * @brief Get the Parity object 获取校验位
	 *
	 * @return return parity 返回校验位 {@link itas109::Parity}
	 */
	virtual itas109::Parity getParity() const;
	/**
	 * @brief Set the Data Bits object 设置数据位
	 *
	 * @param dataBits [in] the dataBits 数据位 {@link itas109::DataBits}
	 */
	virtual void setDataBits(itas109::DataBits dataBits);
	/**
	 * @brief Get the Data Bits object 获取数据位
	 *
	 * @return return dataBits 返回数据位 {@link itas109::DataBits}
	 */
	virtual itas109::DataBits getDataBits() const;

	/**
	 * @brief Set the Stop Bits object 设置停止位
	 *
	 * @param stopbits [in] the stopbits 停止位 {@link itas109::StopBits}
	 */
	virtual void setStopBits(itas109::StopBits stopbits);
	/**
	 * @brief Get the Stop Bits object 获取停止位
	 *
	 * @return return stopbits 返回停止位 {@link itas109::StopBits}
	 */
	virtual itas109::StopBits getStopBits() const;

	/**
	 * @brief Set the Flow Conctrol object 设置流控制
	 * @todo Not implemented 未实现
	 *
	 * @param flowConctrol [in]
	 */
	virtual void setFlowConctrol(itas109::FlowConctrol flowConctrol);
	/**
	 * @brief Get the Flow Conctrol object 获取流控制
	 * @todo Not implemented 未实现
	 *
	 * @return itas109::FlowConctrol
	 */
	virtual itas109::FlowConctrol getFlowConctrol() const;

	/**
	 * @brief Set the Read Buffer Size object 设置读取缓冲区大小
	 *
	 * @param size [in] read buffer size 读取缓冲区大小
	 */
	virtual void setReadBufferSize(int64 size);
	/**
	 * @brief Get the Read Buffer Size object 获取读取缓冲区大小
	 *
	 * @return return read buffer size 返回读取缓冲区大小
	 */
	virtual int64 getReadBufferSize() const;

	/**
	 * @brief Set the Dtr object 设置DTR
	 * @todo Not implemented 未实现
	 *
	 * @param set [in]
	 */
	virtual void setDtr(bool set = true);
	/**
	 * @brief Set the Rts object 设置RTS
	 * @todo Not implemented 未实现
	 *
	 * @param set [in]
	 */
	virtual void setRts(bool set = true);

	/**
	 * @brief Get the Version object 获取版本信息
	 *
	 * @return return version 返回版本信息
	 */
	std::string getVersion();

private:
	/**
	 * @brief lock 锁
	 *
	 */
	void lock();
	/**
	 * @brief unlock 解锁
	 *
	 */
	void unlock();

    /**
     * @brief uart_set
     * @param fd
     * @param baude
     * @param c_flow
     * @param bits
     * @param parity
     * @param stop
     * @return 0 success -1 error
     */
    int uart_set(int fd, int baudRate = itas109::BaudRate9600, itas109::Parity parity = itas109::ParityNone, itas109::DataBits dataBits = itas109::DataBits8, itas109::StopBits stopbits = itas109::StopOne, itas109::FlowConctrol flowConctrol = itas109::FlowNone);

    /**
     * @brief thread monitor 多线程监视器
     *
     */
    static void * commThreadMonitor(void * pParam);

    /**
     * @brief start thread monitor 启动多线程监视器
     *
     * @return
     * @retval true start success 启动成功
     * @retval false start failed 启动失败
     */
    bool startThreadMonitor();
    /**
     * @brief stop thread monitor 停止多线程监视器
     *
     * @return
     * @retval true stop success 停止成功
     * @retval false stop failed 停止失败
     */
    bool stopThreadMonitor();

public:
	static sigslot::signal0<> readReady;///< sigslot for read 读数据信号

private:
	std::string m_portName;
	int m_baudRate;
	itas109::Parity m_parity;
	itas109::DataBits m_dataBits;
	itas109::StopBits m_stopbits;
	itas109::FlowConctrol m_flowConctrol;
	int64 m_readBufferSize;

    int fd; /* File descriptor for the port */

private:
    pthread_t m_monitorThread;  /**< read thread */

    static bool isThreadRunning;

    pthread_mutex_t m_communicationMutex;///< mutex
};
#endif //__CSERIALPORTUNIXBASE_H__
